Help > Reference > Macros > Document object > Flagged property

Flagged property

This property returns or sets the flags for the document in the search results. You can use the FetchFlagged method of the Tab object to get the collection of flagged documents.

The Perceptive Search allows for multiple flags to be stored against each document, this property returns a bitmask representing the stored flags.

Member of

Document

Type

Read-Write Integer Property

The possible values are:

If the document doesn't have a flag, the return value is 0.

To test if a document has a particular flag, you must perform a bitwise AND, for example, to test for Red:

	If (Document.Flagged And 0x04) <> 0 Then
		' The Red Flag is on
	End If

See Also

Macro Object Model

Document